<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Reporting (infer.Absint.Reporting)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">infer</a> &#x00BB; <a href="../index.html">Absint</a> &#x00BB; Reporting</nav><header class="odoc-preamble"><h1>Module <code><span>Absint.Reporting</span></code></h1><p>Type of functions to report issues to the error_log in a spec.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-log_t"><a href="#type-log_t" class="anchor"></a><code><span><span class="keyword">type</span> log_t</span><span> =
  <span><span class="optlabel">?loc_instantiated</span>:<a href="../../IBase/Location/index.html#type-t">IBase.Location.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?ltr</span>:<a href="../Errlog/index.html#type-loc_trace">Errlog.loc_trace</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?extras</span>:<a href="../../ATDGenerated/Jsonbug_t/index.html#type-extra">ATDGenerated.Jsonbug_t.extra</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?suggestion</span>:string <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/Checker/index.html#type-t">IBase.Checker.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/IssueType/index.html#type-t">IBase.IssueType.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span>string <span class="arrow">&#45;&gt;</span></span>
  unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-log_issue_from_summary"><a href="#val-log_issue_from_summary" class="anchor"></a><code><span><span class="keyword">val</span> log_issue_from_summary : 
  <span><span class="optlabel">?severity_override</span>:<a href="../../IBase/IssueType/index.html#type-severity">IBase.IssueType.severity</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../Errlog/index.html#type-t">Errlog.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">node</span>:<a href="../Errlog/index.html#type-node">Errlog.node</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">session</span>:int <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">loc</span>:<a href="../../IBase/Location/index.html#type-t">IBase.Location.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">ltr</span>:<a href="../Errlog/index.html#type-loc_trace">Errlog.loc_trace</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?extras</span>:<a href="../../ATDGenerated/Jsonbug_t/index.html#type-extra">ATDGenerated.Jsonbug_t.extra</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/Checker/index.html#type-t">IBase.Checker.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../IssueToReport/index.html#type-t">IssueToReport.t</a> <span class="arrow">&#45;&gt;</span></span>
  unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-log_issue"><a href="#val-log_issue" class="anchor"></a><code><span><span class="keyword">val</span> log_issue : <span><a href="../../IR/Procdesc/index.html#type-t">IR.Procdesc.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Errlog/index.html#type-t">Errlog.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="label">loc</span>:<a href="../../IBase/Location/index.html#type-t">IBase.Location.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-log_t">log_t</a></span></code></div><div class="spec-doc"><p>Add an issue to the given error log.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-log_issue_external"><a href="#val-log_issue_external" class="anchor"></a><code><span><span class="keyword">val</span> log_issue_external : 
  <span><a href="../../IR/Procname/index.html#type-t">IR.Procname.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">issue_log</span>:<a href="../IssueLog/index.html#type-t">IssueLog.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?severity_override</span>:<a href="../../IBase/IssueType/index.html#type-severity">IBase.IssueType.severity</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">loc</span>:<a href="../../IBase/Location/index.html#type-t">IBase.Location.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="label">ltr</span>:<a href="../Errlog/index.html#type-loc_trace">Errlog.loc_trace</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?access</span>:string <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?extras</span>:<a href="../../ATDGenerated/Jsonbug_t/index.html#type-extra">ATDGenerated.Jsonbug_t.extra</a> <span class="arrow">&#45;&gt;</span></span>
  <span><span class="optlabel">?suggestion</span>:string <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/Checker/index.html#type-t">IBase.Checker.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/IssueType/index.html#type-t">IBase.IssueType.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span>string <span class="arrow">&#45;&gt;</span></span>
  <a href="../IssueLog/index.html#type-t">IssueLog.t</a></span></code></div><div class="spec-doc"><p>Log an issue to the error log in <code>IssueLog</code> associated with the given procname.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_suppressed"><a href="#val-is_suppressed" class="anchor"></a><code><span><span class="keyword">val</span> is_suppressed : 
  <span><span class="optlabel">?field_name</span>:<span><a href="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a> option</span> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IR/Tenv/index.html#type-t">IR.Tenv.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IR/ProcAttributes/index.html#type-t">IR.ProcAttributes.t</a> <span class="arrow">&#45;&gt;</span></span>
  <span><a href="../../IBase/IssueType/index.html#type-t">IBase.IssueType.t</a> <span class="arrow">&#45;&gt;</span></span>
  bool</span></code></div><div class="spec-doc"><p>should an issue report be suppressed due to a <code>@SuppressLint(&quot;issue&quot;)</code> annotation?</p></div></div></div></body></html>
